package com.lam.code.configuration;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author lam
 * @description Swagger2配置
 * @date 2019/10/28 23:25
 */
@Configuration
@EnableSwagger2
@ConditionalOnExpression("${swagger.enabled:true}")
public class SwaggerConfiguration {

    /**
     * 扫描的基础包
     */
    @Value("${swagger.basePackage:com.lam}")
    private String basePackage;

    /**
     * 文档标题
     */
    @Value("${swagger.info.title:Lam接口文档}")
    private String infoTitle;

    /**
     * 文档描述
     */
    @Value("${swagger.info.description:快速搭建企业后台管理系统的基础项目}")
    private String infoDescription;

    /**
     * 文档作者
     */
    @Value("${swagger.info.author:Lam}")
    private String infoAuthor;

    /**
     * 文档版本
     */
    @Value("${swagger.info.version:1.0.0}")
    private String infoVersion;

    /**
     * 创建API
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 1.扫描所有有注解的api
                //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 2.扫描指定包,可扫描不带Swagger注解的方法
                // .apis(RequestHandlerSelectors.basePackage("com.lam.code.controller"))
                // 3.扫描顶级包,可扫描不带Swagger注解的方法
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                // 4.扫描带有@Controller的类
                //.apis(RequestHandlerSelectors.withClassAnnotation(Controller.class))
                // 5.扫描所有
                //.apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(infoTitle)
                .description(infoDescription)
                .contact(new Contact(infoAuthor, null, null))
                .version(infoVersion)
                .build();
    }


}
